docs(natspec): correct stale calculateClearStateChange description#2789
Open
thedavidmeister wants to merge 4 commits into
Open
docs(natspec): correct stale calculateClearStateChange description#2789thedavidmeister wants to merge 4 commits into
thedavidmeister wants to merge 4 commits into
Conversation
The old prose described the counterparty cap as "counterparty IO × max output" which was inherited verbatim from the legacy OrderBook. The actual cap formula (from calculateClearStateAlice) caps each order's input at the counterparty's `outputMax` and back-calculates the output as `input / IORatio`. Refs #2671
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis change updates a NatSpec documentation comment in RaindexV6.sol describing the clear state change calculation, replacing prior wording with a clearer "Alice and Bob" example explaining input/output derivation and capping via IO ratio and outputMax. No executable logic changed. ChangesDocumentation Update
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Corrects the
calculateClearStateChangefunction-level NatSpec inherited verbatim from the legacy OrderBook. The old prose described the output cap as "counterparty IO × max output", but the actual formula (calculateClearStateAlice) caps each order's input at the counterparty'soutputMaxand back-calculates the output asinput / IORatio.No logic or bytecode change; doc-only.
Refs #2671 (item 4 — stale
calculateClearStateChangeNatSpec).Summary by CodeRabbit